docs: add pullbasectl users delete command#3
Conversation
|
Warning Review limit reached
More reviews will be available in 25 minutes and 3 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR documents a new CLI feature that enables user account deletion via ChangesUser deletion CLI documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
reference/cli.mdx (1)
732-749: ⚡ Quick winConsider documenting deletion restrictions and confirmation behavior.
The command documentation is complete and well-structured. To improve user experience, consider adding a note about important deletion restrictions and the confirmation mechanism, similar to the note on
servers delete(lines 211-213).📝 Suggested addition
### `pullbasectl users delete` Delete a user account. <ParamField flag="--user-id" type="integer" required> ID of the user to delete. </ParamField> <ParamField flag="--delete-acct-username" type="string" required> Username of the account to delete (used as confirmation). </ParamField> + +<Note> +Deletion is blocked if you attempt to delete the last active admin or your own account. The `--delete-acct-username` flag serves as confirmation and must match the username associated with the user ID. +</Note> ```bash pullbasectl users delete \🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@reference/cli.mdx` around lines 732 - 749, Update the pullbasectl users delete docs to explicitly describe deletion restrictions and the confirmation behavior: in the `pullbasectl users delete` section mention any constraints (e.g., immutable/system/admin accounts, cascade effects, required permissions) and explain that the --delete-acct-username flag is used as a confirmation step (must match the user's username exactly) similar to the note in the `servers delete` section; reference the command name and flags (--user-id, --delete-acct-username) so readers know where to apply the note.guides/pullbasectl.mdx (1)
165-170: ⚡ Quick winConsider adding a note about deletion restrictions.
The delete example is clear and complete. However, based on the web UI documentation, user deletion has important restrictions (cannot delete the last active admin or your own account). Consider adding a brief tip or note to help users understand these limitations.
📝 Suggested addition
# Delete a user's account docker compose exec central-server pullbasectl users delete \ --server-url http://localhost:8080 \ --user-id 7 \ --delete-acct-username "SomeAccount123" + +<Tip> +User deletion is blocked if you attempt to delete the last active admin or your own account. +</Tip>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@guides/pullbasectl.mdx` around lines 165 - 170, Add a brief note below the "pullbasectl users delete" example explaining deletion restrictions: that you cannot delete the last active admin and you cannot delete your own account; update the guides/pullbasectl.mdx example block that contains the "pullbasectl users delete" command to include a short tip or admonition (one or two sentences) describing these limitations so readers see the constraints when following the example.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@guides/pullbasectl.mdx`:
- Around line 165-170: Add a brief note below the "pullbasectl users delete"
example explaining deletion restrictions: that you cannot delete the last active
admin and you cannot delete your own account; update the guides/pullbasectl.mdx
example block that contains the "pullbasectl users delete" command to include a
short tip or admonition (one or two sentences) describing these limitations so
readers see the constraints when following the example.
In `@reference/cli.mdx`:
- Around line 732-749: Update the pullbasectl users delete docs to explicitly
describe deletion restrictions and the confirmation behavior: in the
`pullbasectl users delete` section mention any constraints (e.g.,
immutable/system/admin accounts, cascade effects, required permissions) and
explain that the --delete-acct-username flag is used as a confirmation step
(must match the user's username exactly) similar to the note in the `servers
delete` section; reference the command name and flags (--user-id,
--delete-acct-username) so readers know where to apply the note.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 23586fd7-d4a3-484c-84af-77f37ce21564
📒 Files selected for processing (2)
guides/pullbasectl.mdxreference/cli.mdx
2 participants
docs: add
pullbasectl users deletecommandSummary
Updates the CLI documentation to reflect the
pullbasectl users deletesubcommand implemented in the companion code PR here pullbase/pullbase#2Previously, the reference docs stated that user deletion required the web UI or REST API and that CLI support was "planned". That note has been replaced with full documentation for the new command.
Changes
reference/cli.mdx<Info>note stating CLI user deletion was planned.### pullbasectl users deletesection documenting the--user-idand--delete-acct-usernameflags and a usage example.guides/pullbasectl.mdxusers deleteexample command to the section.Related
Summary by CodeRabbit